-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Move pkg_resources docs away from the main documents and signal it is no longer supported.
#5173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
c80117a to
32fd0b4
Compare
pkg_resources docs away from the main documents.pkg_resources docs away from the main documents and signal it is no longer supported.
|
You can ignore the mypy issue. It should be fixed by jaraco/jaraco.text#28 |
|
Here's additional non-deprecated, non-historical documentations that assume a still active https://github.com/pypa/setuptools/blob/main/docs/setuptools.rst#transitional-note
This entire section could be moved to your new blurb about transitioning. https://github.com/pypa/setuptools/blob/main/docs/development/index.rst#development-on-setuptools
https://github.com/pypa/setuptools/blob/main/docs/userguide/extension.rst#adding-new-egg-info-files
The historical mention of setuptools + pkgutils can stay. But I'm not sure if it should still give the full example on using them. At least it should be clarified that this is not only deprecated, but no longer supported at all. Either way https://github.com/pypa/setuptools/blob/main/docs/userguide/development_mode.rst#limitations Not sure about this one. Maybe it could be rephrased ?
https://github.com/pypa/setuptools/blob/main/setuptools/dist.py
Additional notes (not in scope of this PR): #5007 (comment) |
32fd0b4 to
9911384
Compare
|
Thanks @Avasam. I am tempted to create a new issue with your whole comment and split it up with follow up(s) PR(s) -- just because in this moment I want the info to get out there (and it will take me time to iterate over all the points you suggested). Also, any further suggestion to improve the text can be revisited in a later PR. |
Remove or update documentation that still refers to ``pkg_resources`` as an actively maintained module, following the deprecation completed in pypa#5173. Changes include: - docs/setuptools.rst: Rewrite Transitional Note to reflect that pkg_resources-style namespace packages are deprecated - docs/development/index.rst: Remove mention of pkg_resources module and reference manual - docs/userguide/distribution.rst: Replace pkg_resources.parse_version() with packaging.version.parse() - docs/userguide/extension.rst: Reference importlib.metadata as the primary API for EGG-INFO access - docs/userguide/package_discovery.rst: Fix ``pkg_resource`` typo (missing 's'), fix ``pkgutils`` typo, add deprecation admonition to Legacy Namespace Packages section - setuptools/dist.py: Replace pkg_resources.require() format reference with PEP 508 in install_requires docstring Closes pypa#5179 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of changes
Closes #3085 (comment)
Pull Request Checklist
newsfragments/.(See documentation for details)